Replace lib:/// scheme by mvn:/// and file:/// and jar+file:/// everywhere #1969

jurgenvinju · 2024-06-10T12:04:27Z

This PR:

removes the implementation and use of the lib:/// scheme. This also removes a lot of printing on stderr.
builts on the introduction of the mvn:/// scheme
moves the original resolution code from the lib:/// scheme implementation to PathConfig.createProjectConfig...
adds path resolution error messages and warnings to a PathConfig field called messages, including version clashes on the rascal and rascal-lsp project, missing pom.xml files, etc.
changes all clients of PathConfig.createProjectConfig to pretty print resolved paths and error messages.

These were the TODO's:

shorten all paths into the local maven repo to mvn:///groupid!artifactid!version
replace lib:/// in the processing of dependencies (Require-Libraries) with other schemes, including mvn, file, and jar+file. This means sometimes dynamically computing an absolute path rather than leaving it to an opaque scheme.
remove Require-Libraries implementation (is replaced by mvn dependency:list and bundle dependencies in Eclipse)
remove lib resolver from the implementation
test, test, test
figure out how the rascal summaries for the IDE can work without the lib:/// scheme that is now introduced by the Packager. Some form of relocation is necessary, but it can't be the old lib:/// scheme anymore.

This fixes #1916, #1961, #1826, #1825, #1824, #1777, #1767, and #1478

Downstream projects like rascal-lsp and rascal-maven-plugin may need some modifications:

In particular everywhere we use URIUtil.correctLocation("lib", name) should become PathConfig.resolveDependencyFromResourcesOnCurrentClasspath("name") or URIUtil.correctLocation("mvn", etc.)
Where we receive a new PathConfig instance we can chose to register or print the diagnostic messages.

…ory'

codecov · 2024-06-10T13:08:55Z

Codecov Report

Attention: Patch coverage is 30.90129% with 322 lines in your changes missing coverage. Please review.

Project coverage is 50%. Comparing base (04a5cbb) to head (a53f908).
Report is 96 commits behind head on main.

Files with missing lines	Patch %	Lines
src/org/rascalmpl/library/util/PathConfig.java	29%	182 Missing and 13 partials ⚠️
src/org/rascalmpl/library/Messages.java	53%	23 Missing and 8 partials ⚠️
...rascalmpl/uri/file/MavenRepositoryURIResolver.java	4%	21 Missing ⚠️
...r/lang/rascal/tutor/repl/TutorCommandExecutor.java	0%	20 Missing ⚠️
src/org/rascalmpl/shell/ShellEvaluatorFactory.java	0%	12 Missing ⚠️
...rg/rascalmpl/interpreter/utils/RascalManifest.java	9%	10 Missing ⚠️
src/org/rascalmpl/uri/URIUtil.java	28%	10 Missing ⚠️
src/org/rascalmpl/shell/CommandOptions.java	0%	5 Missing ⚠️
src/org/rascalmpl/library/util/Reflective.java	33%	3 Missing and 1 partial ⚠️
src/org/rascalmpl/interpreter/Evaluator.java	0%	2 Missing and 1 partial ⚠️
... and 6 more

Additional details and impacted files

@@           Coverage Diff           @@
##              main   #1969   +/-   ##
=======================================
  Coverage       49%     50%           
- Complexity    6575    6587   +12     
=======================================
  Files          698     699    +1     
  Lines        60706   60711    +5     
  Branches      8875    8886   +11     
=======================================
+ Hits         30345   30425   +80     
+ Misses       28122   28030   -92     
- Partials      2239    2256   +17

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…ion and configuration process by adding a messages field to PathConfig

…re and there

… errors that PathConfig creation detects

jurgenvinju · 2024-06-27T13:51:59Z

tests to run

rascal project tests
flybytes project (lots of Java jar dependencies)
salix project
drambiguity project (depends on salix)

``` rascal>resolveLocation(|std:///|) loc: |jar+file:///Users/jurgenv/git/rascal/target/rascal-0.40.3-RC2-SNAPSHOT.jar!/org/rascalmpl/library/| ```

jurgenvinju · 2024-09-14T13:59:53Z

This PR fixes #1961

…hile testing from rascal/target/classes instead of from a jar file. now the tests can succeed as well

…spath

DavyLandman

Some small comments.

pom.xml

src/org/rascalmpl/compiler/Compiler.rsc

src/org/rascalmpl/library/lang/csv/IO.java

src/org/rascalmpl/uri/URIUtil.java

src/org/rascalmpl/uri/file/MavenRepositoryURIResolver.java

…wn class to avoid cyclic static block dependencies

…the stdlib resolver by removing a call to mavenize. tricky business.

…ad projects from a common workspace folder, to be able to deal with the typepal source dependency of the rascal project

…rs to read projects from a common workspace folder, to be able to deal with the typepal source dependency of the rascal project" This reverts commit 7c77df9.

…endency cycle is introduced, and fixed a number of minor issues

…ndency to typepal to a version that has rascal itself provided to avoid loading an older vallang via that route

… This can happen in case of diamond dependencies of open Rascal projects in the IDE

…srcs

jurgenvinju added 2 commits June 10, 2024 14:03

added mavenize method to shorten jar paths in the local maven reposit…

8ff9eae

…ory'

made mavenize and jarify available to Rascal programmers

0608349

jurgenvinju added 11 commits June 11, 2024 18:58

cleanup of PathConfig and added diagnostics to the dependency resolut…

5a5d5a4

…ion and configuration process by adding a messages field to PathConfig

not finished yet but getting there with the PathConfig refurbishing

086aa60

implemented Messages

37e3c96

Merge branch 'main' into replace-lib-by-mvn-and-others

002e2f0

Merge branch 'main' into replace-lib-by-mvn-and-others

f0b8709

cleaning up after changing PathConfig. Also removed unused imports he…

4d8ba06

…re and there

removed the lib:/// scheme from the implementation

b212c7e

added target folder back to the classpath for loading Java classes

f879803

Merge branch 'main' into replace-lib-by-mvn-and-others

339eaea

the shell evaluator factory and junit evaluator creator now print the…

3034ebd

… errors that PathConfig creation detects

some cleanup

e3248de

jurgenvinju added 10 commits June 27, 2024 15:52

improved message printing

1ed3643

improved message printing

b83b6f3

improved configuration checking code

66fd82b

improved error messages

107f687

finetuning interpreter mode wrt std library linkage

63ea033

changed warning message

f767142

The std scheme is not opaque anymore but transparant

38bdf96

``` rascal>resolveLocation(|std:///|) loc: |jar+file:///Users/jurgenv/git/rascal/target/rascal-0.40.3-RC2-SNAPSHOT.jar!/org/rascalmpl/library/| ```

added more comments

a14a82a

Merge branch 'main' into replace-lib-by-mvn-and-others

72b2ba6

fixed false positive project name error if the project:// scheme is used

d076cf0

jurgenvinju added 4 commits September 16, 2024 10:20

removed unused import

5ea2006

fixed issue in std:// resolver in the case where we are applying it w…

ac8080f

…hile testing from rascal/target/classes instead of from a jar file. now the tests can succeed as well

added proper warning for conflicting rascal-lsp instances on the clas…

11739c4

…spath

fixed typo

cb4b38e

DavyLandman reviewed Feb 6, 2025

View reviewed changes

jurgenvinju added 26 commits February 7, 2025 23:10

some cleanup and factored out the shared monitor for testing in its o…

f495574

…wn class to avoid cyclic static block dependencies

removed cyclic static dependency between the maven repo resolver and …

11441fc

…the stdlib resolver by removing a call to mavenize. tricky business.

cleaned up two debug prints

62f0d85

removed another debug print

fa903ab

added test import to the test Compiler module

c264c62

generalized commandline version of project and target resolvers to re…

7c77df9

…ad projects from a common workspace folder, to be able to deal with the typepal source dependency of the rascal project

|project:///| exists now due to the changes in the project scheme

0e0fac9

Revert "generalized commandline version of project and target resolve…

5786fc3

…rs to read projects from a common workspace folder, to be able to deal with the typepal source dependency of the rascal project" This reverts commit 7c77df9.

added typepal as provided dependency (not transitive such that no dep…

a2ee793

…endency cycle is introduced, and fixed a number of minor issues

small improvements

31dec22

filtering the rascal project from mvn depenendencies, and stting depe…

ba46e2d

…ndency to typepal to a version that has rascal itself provided to avoid loading an older vallang via that route

added non-rascal dependencies to lib path

c8e1b91

do not add rascal project as lib

0dc1ad4

fixed bugs wrt rascal project self-application

eb55739

cleaning up a bit

4524579

automatically remove duplicates in srcs and libs lists of pathconfig.…

8408e99

… This can happen in case of diamond dependencies of open Rascal projects in the IDE

removed unused import

17f0f84

a bit of static initializer fun

d74cfec

fixed weird problem in Reflective project generator

96aeb0a

extra std:// in srcs makes this test run wild

c2a9097

added test data and benchmark source folders for self-application to …

de71ce1

…srcs

simplified URIUtil.getExtension via @DavyLandman

be8791f

added deprecated invalidLocation function

91fb236

more javadoc

ff912c1

Merge branch 'main' into replace-lib-by-mvn-and-others

f4d577d

weird merge issue solved

a53f908

DavyLandman approved these changes Feb 26, 2025

View reviewed changes

DavyLandman merged commit bf583ae into main Feb 26, 2025
6 of 7 checks passed

DavyLandman deleted the replace-lib-by-mvn-and-others branch March 10, 2025 22:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace lib:/// scheme by mvn:/// and file:/// and jar+file:/// everywhere #1969

Replace lib:/// scheme by mvn:/// and file:/// and jar+file:/// everywhere #1969

jurgenvinju commented Jun 10, 2024 •

edited

Loading

codecov bot commented Jun 10, 2024 •

edited

Loading

jurgenvinju commented Jun 27, 2024 •

edited

Loading

jurgenvinju commented Sep 14, 2024

DavyLandman left a comment

Replace lib:/// scheme by mvn:/// and file:/// and jar+file:/// everywhere #1969

Replace lib:/// scheme by mvn:/// and file:/// and jar+file:/// everywhere #1969

Conversation

jurgenvinju commented Jun 10, 2024 • edited Loading

codecov bot commented Jun 10, 2024 • edited Loading

Codecov Report

jurgenvinju commented Jun 27, 2024 • edited Loading

jurgenvinju commented Sep 14, 2024

DavyLandman left a comment

Choose a reason for hiding this comment

jurgenvinju commented Jun 10, 2024 •

edited

Loading

codecov bot commented Jun 10, 2024 •

edited

Loading

jurgenvinju commented Jun 27, 2024 •

edited

Loading